MarkLogic Server 11.0 Product Documentation
GET /manage/v2/clusters/{id|name}?view=status

Summary

This resource address returns a status summary for the specified foreign cluster.

URL Parameters
format The format of the returned data. Can be either html, json, or xml (default). This value overrides the Accept header if both are present.
Request Headers
Accept The expected MIME type of the response. If the format parameter is present, it takes precedence over the Accept header.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.

Response

Upon success, MarkLogic Server returns status code 200 (OK). The response body contains the requested data.

Required Privileges

This operation requires the manage-user role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage

Usage Notes

Address the local cluster at /manage/v2, without specifying the full /manage/v2/clusters/{id|name}.

The structure of the output returned from this REST API is as follows:

id

A cluster ID.

name

A cluster name.

role

The role (local or foreign ) of the cluster in the current environment.

meta

Properties of the view rather than the resource.

This is a complex structure with the following children:

uri

The path to the view.

current-time

The timestamp for when the view was generated.

elapsed-time

The time required to construct the view. The elapsed time indicates the relative cost of generating the view. Consider the cost when determining how frequently to request a view.

start-min

The timestamp for filtering out more recent requests or transactions.

view-error

An error limiting the data in the view.

This is a complex structure with the following children:

error-type

The kind of error.

error-name

The name of the error.

error-code

The error identifier.

error-message

The error text.

relations

Relationships to resources.

This is a complex structure with the following children:

relation-group

Related resources with the same type.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

relation-count

The number of related resources.

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

foreign-status-properties

The operating characteristics of the foreign cluster.

This is a complex structure with the following children:

is-bootstrapped

A flag indicating whether all bootstrap hosts are bootstrapped to the foreign cluster.

bootstrap-host-detail

A foreign cluster status

This is a complex structure with the following children:

host-id

The unique key of the host

interesting

Is this interesting.

bootstrapped

Is this bootstrapped.

last-successful-bootstrap

The time of the last bootstrap.

foreign-hosts

Information about foreign hosts.

This is a complex structure with the following children:

foreign-host

This is a complex structure with the following children:

foreign-host-id

The ID of the foreign host.

foreign-host-name

The name of the foreign host.

foreign-connect-port

The connect port for the foreign host.

online

Is this online.

secure

Is SSL enabled.

last-online

The time it was last online.

last-offline

The time it was last offline.

foreign-databases

Information about foreign databases.

This is a complex structure with the following children:

foreign-database

Information about a particular foreign database.

This is a complex structure with the following children:

foreign-database-id

The ID of the foreign database.

foreign-database-name

The name of the foreign database.

enabled

Is this enabled.

foreign-forest-ids

This is a complex structure with the following children:

foreign-forest-id

The ID of the foreign forest.

foreign-forests

Information about foreign forests.

This is a complex structure with the following children:

foreign-forest

Information about a particular foreign forest.

This is a complex structure with the following children:

foreign-forest-id

The ID of the foreign forest.

foreign-forest-name

The name of the foreign forest.

foreign-host-id

The ID of the foreign host.

related-views

A list of broader or narrower views on the resource or resource type.

This is a complex structure with the following children:

related-view

A broader or narrower view on the resource or resource type.

This is a complex structure with the following children:

view-type

The kind of view.

view-name

The name of the view.

view-uri

The path for the view.

Example


  http://localhost:8002/manage/v2/clusters/Replica?view=status

  ==>  Returns status informaton for the foreign cluster named Replica.
Powered by MarkLogic Server | Terms of Use | Privacy Policy